home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / rabir210.zip / rabirth.doc < prev    next >
Text File  |  1993-07-21  |  12KB  |  421 lines
  1.  
  2.   ╔════════════════════════════════════════════════════════════════════════╗
  3.   ║░░░░░ RABIRTH ░░░░░ For RemoteAccess 1.11/2.00 ░░░░░ Documentation ░░░░░║
  4.   ╚════════════════════════════════════════════════════════════════════════╝
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                                 RABIRTH 2.10
  26.  
  27.                   A birthday utility for RemoteAccess 1.xx
  28.                             and RemoteAccess 2.xx
  29.  
  30.  
  31.                      (c) 1991, 1992, 1993 Hamish Moffatt
  32.  
  33.  
  34.  
  35.                               Fidonet 3:635/552
  36.  
  37.  
  38.  
  39.                                 Documentation
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.   ╔════════════════════════════════════════════════════════════════════════╗
  64.   ║░░░░░ RABIRTH ░░░░░ For RemoteAccess 1.11/2.00 ░░░░░ Documentation ░░░░░║
  65.   ╚════════════════════════════════════════════════════════════════════════╝
  66.  
  67.  
  68.    Introduction
  69.    ════════════
  70.  
  71.    RABIRTH is a  utility for  RemoteAccess  1.00 and later  (including 2.00).
  72.    RABIRTH does  a  number of things  with a user's  birthdate field in  the 
  73.    user record, and other birthdate sources.
  74.  
  75.    RABIRTH works with RemoteAccess 1.11, 2.00, and ProBoard 1.30.
  76.  
  77.    Features of RABIRTH
  78.    ═══════════════════
  79.  
  80.         ■ ANS/ASC/AVT List of all users and their birthdays.
  81.         ■ ANS/ASC/AVT List of all users having birthdays this month.
  82.         ■ ANS/ASC/AVT List of users with birthdays today/tomorrow/yesterday.
  83.  
  84.  
  85.         ■ Post messages to  users on  their birthdays  using a template file 
  86.           with $macros.
  87.         ■ Message base locking for multinode systems.
  88.         ■ Send  users  their  birthday  messages  through  netmail  or  even
  89.           through your local Internet/UUCP gateway.
  90.         ■ Define people (such as your friends) to  send birthday messages to 
  91.           through netmail/UUCP who aren't even users of your BBS!
  92.  
  93.  
  94.         ■ Full handle support, on messages and bulletin screens.
  95.         ■ Log for sysop of birthdays today, messages posted, errors.
  96.         ■ Opus or FrontDoor log.
  97.         ■ Support for hidden users.
  98.  
  99.  
  100.         ■ Configuration  of  most  parameters,  including  all text  strings
  101.           and colours.  English, Italian and  German language configurations
  102.           are included in the package.
  103.  
  104.  
  105.    RABIRTH 2.10 has been tested with RemoteAccess 1.11 and 2.00 beta/gamma.
  106.    Unfortunately RABIRTH has not been tested with ProBoard 1.30, but since
  107.    since ProBoard is RA 1.11 compatible, there should be no problems.
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.         RABIRTH 2.10 Documentation                              Page 1
  120.  
  121.  
  122.  
  123.    Configuration of RABIRTH
  124.    ════════════════════════
  125.  
  126.    RABIRTH is configured by a standard text  file (called RABIRTH.CFG) which 
  127.    you must create with  your favourite  text editor  (a sample is supplied). 
  128.    RABIRTH.CFG uses keywords like  most  other  configuration  files.
  129.  
  130.    RABIRTH 2.10's  configuration is  vastly different  from that of  RABIRTH
  131.    1.xx,  so you  must set  it up  from scratch.  This should be  reasonably 
  132.    painless though.  If you are using  RABIRTH 2.0x,  it is recommended that
  133.    you reconfigure RABIRTH, but if you are running RA 1.11, this is not abso-
  134.    -lutely necessary (though still encouraged).
  135.  
  136.    Specifics of the configuration can be found in RABIRTH.CFG.
  137.  
  138.  
  139.    Language Configuration
  140.    ══════════════════════
  141.  
  142.    RABIRTH also allows you to  configure all its text  strings.  The default 
  143.    language file is RABIRTH.LNG.  (You can override this with a command line 
  144.    parameter). If you wish  to change any  strings or translate,  please see
  145.    your RABIRTH.LNG. It contains all you need to know to change anything.
  146.  
  147.    Examples are supplied in several languages; English (ENGLISH.LNG), German
  148.    (GERMAN.LNG), Italian (ITALIAN.LNG), and Hebrew (HEBREW.LNG). These files
  149.    can be found in LANGUAGE.ARJ, included in your RABIRTH archive.
  150.  
  151.    The included RABIRTH.LNG (the default language filename) is a copy of the 
  152.    English language file. If you create a language file for another language,
  153.    please send it to me  (at the addresses below)  for inclusion in a future
  154.    release of RABIRTH.
  155.  
  156.  
  157.    Message Template Macros
  158.    ═══════════════════════
  159.  
  160.    The message template file is named RABIRTH.TXT. The message text found in 
  161.    RABIRTH.TXT will be sent to users on their birthdays.
  162.  
  163.  
  164.    RABIRTH supports several $macros (or metastrings) in the message template
  165.    file. These are as follows. 
  166.  
  167.         Macro           Translates to           Eg
  168.         ══════════════════════════════════════════════════════════
  169.         $name           user's full name        Hamish Moffatt
  170.         $first          user's first name       Hamish
  171.         $last           user's other names      Moffatt
  172.         $handle         user's handle if set    Hamster
  173.         $dayname        name of day of week     Friday
  174.         $monthname      name of month           October
  175.         $day            day of month            11
  176.         $dayth          day with suffix         11th
  177.  
  178.  
  179.         RABIRTH 2.10 Documentation                              Page 2
  180.  
  181.  
  182.  
  183.         Macro           Translates to           Eg
  184.         ══════════════════════════════════════════════════════════
  185.         $month          month of year           10
  186.         $year           year                    1991
  187.         $birthyear      year of user's birth    1976
  188.         $age            age of user             14
  189.       * $ageth          age with suffix         14th
  190.  
  191.  
  192.    * Important note:  while $dayth will return  the correct day  number  and
  193.      suffix from  the language  configuration,  $ageth is NOT  change-able - 
  194.      the suffix is always in English! If you use a foreign language,   avoid 
  195.      use of $ageth. 
  196.  
  197.  
  198.    Example:
  199.  
  200.  
  201.    Hello $handle!
  202.  
  203.    It has come to our attention that today, $dayname, $monthname $day, $year, 
  204.    you have turned $age!
  205.  
  206.    Happy Birthday from the users of Cloud Nine!
  207.  
  208.    Regards,
  209.    Hamish Moffatt
  210.  
  211.   
  212.    When sent to a user, this would appear something like:
  213.  
  214.  
  215.    Hello Hamster!
  216.  
  217.    It has come to our attention that today, Friday, October 11, 1991,
  218.    you have turned 24!
  219.  
  220.    Happy Birthday from the users of Cloud Nine!
  221.  
  222.    Regards,
  223.    Hamish Moffatt
  224.  
  225.  
  226.    Running RABIRTH
  227.    ═══════════════
  228.  
  229.    RABIRTH  requires   no  command  line  parameters,   but  there  are  two
  230.    you can  use;  see below.  When  RABIRTH is run  (by typing  RABIRTH,  or 
  231.    from a batch file), it will display something like the following.
  232.  
  233.  
  234.  
  235.         ■ RABIRTH 2.10 for RemoteAccess 1.xx/2.xx and ProBoard 1.30
  236.         ■ Written by Hamish Moffatt of 3:635/552@fidonet
  237.  
  238.  
  239.         RABIRTH 2.10 Documentation                              Page 3
  240.  
  241.  
  242.  
  243.         ■ Processing configuration file (RABIRTH.CFG)
  244.         ■ Processing language definition file (RABIRTH.LNG)
  245.         ■ Running in RemoteAccess 2.xx mode.
  246.  
  247.         ■ Working...
  248.  
  249.         ■ 0 user(s) have birthdays today
  250.         ■ 2 user(s) have birthdays tomorrow
  251.         ■ 0 user(s) had  birthdays yesterday
  252.  
  253.         ■ Thanks for registering!
  254.         ■ Done
  255.  
  256.  
  257.    If "REPORT" is turned on in your configuration file you may see a warning
  258.    that RABIRTH found a multitasking environment & MULTINODE was not active.
  259.    This is not serious, just a warning. Only DESQview and LANtastic are curr-
  260.    rently detected.
  261.  
  262.    The following command line switches can alter the behavior of RABIRTH.
  263.  
  264.                    -C<filename>     Use the file specified as the configurat-
  265.                                     ion file, rather than RABIRTH.CFG.  This
  266.                                     may be  useful in multiline or  multiple
  267.                                     language systems.
  268.  
  269.                 -L<filename>        Use the file  specified as the  language 
  270.                                     file rather than RABIRTH.LNG. Again this
  271.                                     may be  useful if  you want  to  attempt 
  272.                                     multiple languages.
  273.  
  274.  
  275.    Legal section (do not stop reading here!)
  276.    ════════